Salesforce UX API icon

Salesforce UX API

1.1.x
(0 reviews)

TMF666- UpdateAccount-inAria-AutoPay-NonAutoPay-PR

Change The Autopay/non-Autopay Method, should result in Dunning Process updated in Aria

URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/billingAccount/{id}
url Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.Y
idstringUnique identifier of the accountY
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel.Y
client_secretstringPassword associated with the client_id.Y
X-Correlation-IDstringAn identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications.
Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request		Y*
channelIdstringChannel to business: Eg: "SFDC-B2C"Y
lobstringThe Line of Business Identifier, Eg: POSTPAIDY
targetSystemStringThis describes the end system, Eg: “Aria".Y

Body

autoPay Request
{
    "defaultPaymentMethod": {
        "@referredType": "AutoPay",
        "id": "PAYMENT-633",
        "name": "AutoPay_Due_10_PR",
        "@type":"ACH"
    },
    "relatedParty": [
        {
            "id": "CA-305557-BG",
            "@type": "BillingGroupRef"
        }
    ],
    "financialAccount": {
        "id": "CA-305557-DG",
        "@type": "DunningGroupRef"
    },
    "characteristic": [
        {
            "valueType": "string",
            "value": "Methods",
            "name": "paymentOption"
        },
        {
            "valueType": "any",
            "value": 1,
            "name": "collections_grp_directive"
        },
        {
            "valueType": "string",
            "value": "Medium",
            "name": "riskProfileId"
        }
    ]
}
nonAutoPay Request
{
    "defaultPaymentMethod": {
        "@referredType": "NonAutoPay",
        "name": "Net_23_Days"
    },
    "relatedParty": [
        {
            "id": "CA-305557-BG",
            "@type": "BillingGroupRef"
        }
    ],
    "financialAccount": {
        "id": "CA-305557-DG",
        "@type": "DunningGroupRef"
    },
    "characteristic": [
        {
            "valueType": "string",
            "value": "Terms",
            "name": "paymentOption"
        },
        {
            "valueType": "string",
            "value": "High",
            "name": "riskProfileId"
        }
    ]
}
Definitions
nametypedescriptionrequired
defaultPaymentMethodobjectPayment method details objectY*
defaultPaymentMethod.idPrimary or default unique identifier for the payment method id.
Note – If defaultPaymentMethod Object is coming for updates, then defaultPaymentMethod.id is mandatory to enable AutoPay scenario (conditional mandatory)		Y*
defaultPaymentMethod.nameClient-defined identifier of the collection group to assign to the specified billing group.
Note - collection group value will be “AutoPay_Due_X_PR": "where X could be 0 to 18" as per Aria system		Y
defaultPaymentMethod.@typePayment Method Type. Eg: ACH, Credit_Card, etc.Y*
defaultPaymentMethod.@referredTypeAutopay/Non-AutopayY*
relatedPartyRelated Entity reference. A related party defines party or party role linked to a specific entityY
relatedParty.idClient-defined unique identifier for billing groupY
relatedParty.@typeType of the related partyY
financialAccountA financial Account referenceY
financialAccount.idThe client-defined identifier of the dunning group.Y
financialAccount.@typeType of accountY
characteristicA list of characteristics. Describes the characteristic of a billing account. Please refer below characteristic values table for more details.Y*
characteristic.nameName of the characteristicY*
characteristic.valueThe value of the characteristicY*
characteristic Values
nametypedescriptionrequired
paymentOptionThis allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'.
Conditional mandatory - for the Methods (payment_option) it's mandatory		Y*
collections_grp_directiveWhether to add or remove the collection group to or from the specified billing group.
Conditional mandatory - for the AutoPay scenario it's mandatory		Y*
riskProfileIdClient-defined dunning process identifier. Eg: HIGH, MEDIUM, LOWY

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - PATCH request processed successfully, response body contains an entity corresponding to the requested resource.

autoPay Response
{
    "defaultPaymentMethod": {
        "@referredType": "AutoPay",
        "id": "PAYMENT-632",
        "name": "AutoPay_Due_10_PR",
        "@type": "ACH"
    },
    "financialAccount": {
        "id": "CA-305557-DG",
        "@type": "DunningGroupRef"
    },
    "characteristic": [
        {
            "valueType": "string",
            "value": "Methods",
            "name": "paymentOption"
        },
        {
            "valueType": "any",
            "value": 1,
            "name": "collections_grp_directive"
        },
        {
            "valueType": "string",
            "value": "Medium",
            "name": "riskProfileId"
        }
    ],
    "accountRelationship": [
        {
            "account": {
                "id": "1469060",
                "@type": "billing_group_no",
                "@referredType": "BillingAriaAccount"
            }
        },
        {
            "account": {
                "id": "40335578",
                "@type": "stmt_contact_no",
                "@referredType": "BillingAriaAccount"
            }
        },
        {
            "account": {
                "id": "40335588",
                "@type": "bill_contact_no",
                "@referredType": "BillingAriaAccount"
            }
        }
    ]
}
nonAutoPay Response
{
    "defaultPaymentMethod": {
        "@referredType": "NonAutoPay",
        "name": "Net_23_Days"
    },
    "financialAccount": {
        "id": "12345-DG",
        "@type": "DunningGroupRef"
    },
    "characteristic": [
        {
            "valueType": "string",
            "value": "Terms",
            "name": "paymentOption"
        },
        {
            "valueType": "string",
            "value": "High",
            "name": "riskProfileId"
        }
    ],
    "accountRelationship": [
        {
            "account": {
                "id": "1469814",
                "@type": "billing_group_no",
                "@referredType": "BillingAriaAccount"
            }
        },
        {
            "account": {
                "id": "40337487",
                "@type": "stmt_contact_no",
                "@referredType": "BillingAriaAccount"
            }
        }
    ],
    "relatedParty": [
        {
            "id": "12345-BG",
            "@type": "BillingGroupRef"
        }
    ]
}
Definitions
nametypedescriptionrequired
accountRelationshiparrayaccount arrayN
accountRelationship.accountobjectaccount objectN
accountRelationship.account.@referredTypeStringReferred typeN
accountRelationship.account.@typeStringAria field nameN
accountRelationship.account.idStringbilling group numberN
appended the json request paylaodN

Reviews